<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ycrcb2rgb: Main Page</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ycrcb2rgb
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('index.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">ycrcb2rgb Documentation</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This header file contains identifiers and register-level driver functions (or macros), range macros, structure typedefs that can be used to access the Xilinx YCRCB2RGB core. The YCrCb to RGB Color-Space Convertor core is a simplified 3x3 matrix multiplier converts three input color samples to three output samples in a single clock cycle. The core supports four common format conversions as well as a custom mode that allows for a user-defined transform. The core is capable of a maximum resolution of 7680 columns by 7680 rows with 8, 10, 12, or 16 bits per pixel.</p>
<p><b>Initialization &amp; Configuration</b></p>
<p>The device driver enables higher layer software (e.g., an application) to communicate to the YCRCB2RGB core.</p>
<p><a class="el" href="group__ycrcb2rgb__v7__0.html#gac5025d0ba54b65adaa027af5fb417af6" title="This function initializes the YCrCb2Rgb core. ">XYCrCb2Rgb_CfgInitialize()</a> API is used to initialize the YCRCB2RGB core. The user needs to first call the <a class="el" href="group__ycrcb2rgb__v7__0.html#gaf219e40b4fdec9d5653ecedabf57ebeb" title="This function returns a reference to an XYCrCb2Rgb_Config structure based on the unique core id...">XYCrCb2Rgb_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="group__ycrcb2rgb__v7__0.html#gac5025d0ba54b65adaa027af5fb417af6" title="This function initializes the YCrCb2Rgb core. ">XYCrCb2Rgb_CfgInitialize()</a> API.</p>
<p><b> Interrupts </b></p>
<p>The driver provides an interrupt handler XYCrCb2Rgb_IntrHandler for handling the interrupt from the YCRCB2RGB core. The users of this driver have to register this handler with the interrupt system and provide the callback functions by using XYCrCb2Rgb_SetCallBack API.</p>
<p><b> Virtual Memory </b></p>
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
<p><b> Threads </b></p>
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
<p><b> Asserts </b></p>
<p>Asserts are used within all Xilinx drivers to enforce constraints on argument values. Asserts can be turned off on a system-wide basis by defining, at compile time, the NDEBUG identifier. By default, asserts are turned on and it is recommended that users leave asserts on during development.</p>
<p><b> Building the driver </b></p>
<p>The <a class="el" href="struct_x_y_cr_cb2_rgb.html" title="The XYCrCb2Rgb driver instance data structure. ">XYCrCb2Rgb</a> driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.</p>
<pre>
  MODIFICATION HISTORY:</pre><pre>  Ver   Who    Date     Changes
<hr/>

  5.00a tb     02/28/12 Updated for YCRCB2RGB V5.00.a
  5.01a bao    12/28/12 Converted from xio.h to xil_io.h, translating basic
                        types, MB cache functions, exceptions and assertions
                        to xil_io format.
  6.0   adk    19/12/13 Updated as per the New Tcl API's
  7.0   adk    01/31/14 Changed the file name from "ycrcb2rgb.h" to
                        "xycrcb2rgb.h".</pre><pre>                        Moved register offsets and bit definitions from
                        ycrcb2rgb.h file to <a class="el" href="xycrcb2rgb__hw_8h.html">xycrcb2rgb_hw.h</a> file.</pre><pre>                        Removed YCC_TIMING_STATUS register offset because this
                        register is not present in latest product guide.</pre><pre>                        Removed following function macros:
                        YCC_Enable, YCC_Disable, YCC_RegUpdateEnable,
                        YCC_RegUpdateDisable, YCC_Reset, YCC_ClearReset,
                        YCC_AutoSyncReset, ycc_max..</pre><pre>                        Removed following functions:
                        YCC_select_standard, YCC_coefficient_translation,
                        YCC_set_coefficients, YCC_get_coefficients.</pre><pre>                        Added following handler types as enum:
                        XYCC_HANDLER_PROCSTART, XYCC_HANDLER_FRAMEDONE,
                        XYCC_HANDLER_ERROR.</pre><pre>                        Added following standard types as enum:
                        XYCC_STANDARD_ITU_601_SD, XYCC_STANDARD_ITU_709_NTSC,
                        XYCC_STANDARD_ITU_709_PAL, XYCC_STANDARD_YUV,
                        XYCC_STANDARD_CUSTOM.</pre><pre>                        Added following output ranges as enum:
                        XYCC_TV_16_TO_240, XYCC_STUDIO_16_TO_235,
                        XYCC_GRAPHICS_0_TO_255.</pre><pre>                        Added range macros for ActiveSize, RGBMAX, RGBMIN,
                        ROFFSET, GOFFSET, BOFFSET registers.</pre><pre>                        Added following function macros:
                        XYCrCb2Rgb_IntrEnable, XYCrCb2Rgb_IntrDisable,
                        XYCrCb2Rgb_StatusGetPending, XYCrCb2Rgb_IntrGetPending,
                        XYCrCb2Rgb_IntrClear, XYCrCb2Rgb_Reset,
                        XYCrCb2Rgb_Enable, XYCrCb2Rgb_Disable,
                        XYCrCb2Rgb_Start, XYCrCb2Rgb_Stop,
                        XYCrCb2Rgb_RegUpdateEnable,
                        XYCrCb2Rgb_RegUpdateDisable,
                        XYCrCb2Rgb_SyncReset, XYCrCb2Rgb_Max</pre><pre>                        Added core, configuration and coefficient structure.
                        Renamed ycc_coef_inputs -&gt; <a class="el" href="struct_x_y_cr_cb2_rgb___coef___inputs.html" title="YCrCb2Rgb input coefficient. ">XYCrCb2Rgb_Coef_Inputs</a> and
                        ycc_coef_outputs - &gt; <a class="el" href="struct_x_y_cr_cb2_rgb___coef___outputs.html" title="YCrCb2Rgb output coefficient. ">XYCrCb2Rgb_Coef_Outputs</a>.</pre><pre>                        Added callback functions typedef.</pre><pre>                        Implemented XYCrCb2Rgb_LookupConfig in
                        <a class="el" href="xycrcb2rgb__sinit_8c.html">xycrcb2rgb_sinit.c</a>
                        Implemented XYCrCb2Rgb_SelfTest in
                        <a class="el" href="xycrcb2rgb__selftest_8c.html">xycrcb2rgb_selftest.c</a>
                        Implemented XYCrCb2Rgb_IntrHandler,
                        XYCrCb2Rgb_SetCallBack in <a class="el" href="xycrcb2rgb__intr_8c.html">xycrcb2rgb_intr.c</a>.</pre><pre>                        Implemented following functions in <a class="el" href="xycrcb2rgb_8c.html">xycrcb2rgb.c</a>:
                        XYCrCb2Rgb_CfgInitialize, XYCrCb2Rgb_EnableDbgByPass,
                        XYCrCb2Rgb_IsDbgByPassEnabled,
                        XYCrCb2Rgb_DisableDbgBypass,
                        XYCrCb2Rgb_EnableDbgTestPattern,
                        XYCrCb2Rgb_IsDbgTestPatternEnabled,
                        XYCrCb2Rgb_DisableDbgTestPattern,
                        XYCrCb2Rgb_GetVersion, XYCrCb2Rgb_GetDbgFrameCount,
                        XYCrCb2Rgb_GetDbgLineCount,
                        XYCrCb2Rgb_GetDbgPixelCount, XYCrCb2Rgb_Setup,
                        XYCrCb2Rgb_SetActiveSize, XYCrCb2Rgb_GetActiveSize,
                        XYCrCb2Rgb_SetRGBMax, XYCrCb2Rgb_GetRGBMax,
                        XYCrCb2Rgb_SetRGBMin, XYCrCb2Rgb_GetRGBMin,
                        XYCrCb2Rgb_SetROffset, XYCrCb2Rgb_GetROffset,
                        XYCrCb2Rgb_SetGOffset, XYCrCb2Rgb_GetGOffset,
                        XYCrCb2Rgb_SetBOffset, XYCrCb2Rgb_GetBOffset,
                        XYCrCb2Rgb_SetCoefs, XYCrCb2Rgb_GetCoefs,
                        XYCrCb2Rgb_Select_Standard,
                        XYCrCb2Rgb_Coefficient_Translation,
                        XYCrCb2Rgb_Select_OutputRange.
  7.1   ms     01/31/17 Updated the parameter naming from
                        XPAR_YCRCB2RGB_NUM_INSTANCES to
                        XPAR_XYCRCB2RGB_NUM_INSTANCES to avoid compilation
                        failure for XPAR_YCRCB2RGB_NUM_INSTANCES
                        as the tools are generating
                        XPAR_XYCRCB2RGB_NUM_INSTANCES in the generated
                        xycrcb2rgb_g.c for fixing MISRA-C files. This is a
                        fix for CR-967548 based on the update in the tools.
        ms     03/17/17 Added readme.txt file in examples folder for doxygen
                        generation.
*</pre> </div></div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
